Skip to content

Conversation

@zimeg
Copy link
Member

@zimeg zimeg commented Apr 18, 2025

Summary

This PR uses different GitHub app tokens for updating upstream documentation and updating the go version.

Fixes an issue where the prior token didn't have the right permissions to sync with docs. Or had the right permissions? 📚

Notes

  • I'm not sure if these suffixes make the most sense - open to suggestions! - but if it seems alright I can include a note in comments or the MAINTAINERS_GUIDE.md about these apps? 🤔

Requirements

@zimeg zimeg added semver:patch Use on pull requests to describe the release version increment build M-T: Changes to compilation and CI processes labels Apr 18, 2025
@zimeg zimeg added this to the Next Release milestone Apr 18, 2025
@zimeg zimeg self-assigned this Apr 18, 2025
@codecov
Copy link

codecov bot commented Apr 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.90%. Comparing base (edb8e97) to head (82c355e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #52      +/-   ##
==========================================
+ Coverage   62.89%   62.90%   +0.01%     
==========================================
  Files         210      210              
  Lines       22154    22154              
==========================================
+ Hits        13934    13937       +3     
+ Misses       7132     7131       -1     
+ Partials     1088     1086       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zimeg
Copy link
Member Author

zimeg commented Apr 18, 2025

Nice! 🎉

> [email protected] build
> docusaurus build

The GH_APP_ID_DOCS token found documentation 🔍 ✨

@zimeg zimeg marked this pull request as ready for review April 18, 2025 23:07
@zimeg zimeg requested review from a team as code owners April 18, 2025 23:07
@zimeg
Copy link
Member Author

zimeg commented Apr 18, 2025

Shoutouts also to @kkemple for ideas on this change 👾

Copy link
Member Author

@zimeg zimeg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 A note on the hidden meaning of secret variables in action inputs follow-

Comment on lines -15 to -16
app-id: ${{ secrets.GH_APP_ID }}
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tokens were for the kind @slack-cli-releaser[bot] of #5.

If these changes are alright I plan to delete these secrets to avoid future confusions 🫡

Copy link
Member

@mwbrooks mwbrooks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM @zimeg!

📔 I like how you've chosen to post-fix the environment variables with _RELEASER and _DOCS to keep them separate. Is it documented somewhere what permissions each token needs?

🗑️ Once we confirm things are working, it's definitely a good idea to delete the unused secrets.

@zimeg
Copy link
Member Author

zimeg commented Apr 21, 2025

@mwbrooks Wonderful callouts and suggestion once more! I appreciate a second set of eyes on these changes so much 🙏 ✨

I like how you've chosen to post-fix the environment variables

Interesting patterns appear with more variables! I tried other combinations but realized these got cluttered within the repo settings...

I am also finding the "Build Docusaurus" step is successful with the updated secrets, so I will merge this PR. Then deleting secrets unused will be next.

@zimeg zimeg merged commit dbebe74 into main Apr 21, 2025
7 checks passed
@zimeg zimeg deleted the zimeg-ci-gh-tokens branch April 21, 2025 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build M-T: Changes to compilation and CI processes semver:patch Use on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants